<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>py3dtilers.ObjTiler.ObjTiler API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>py3dtilers.ObjTiler.ObjTiler</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import os
import sys
from pathlib import Path

from ..Common import Tiler
from .obj import Objs


class ObjTiler(Tiler):

    def __init__(self):
        super().__init__()

        # adding positional arguments
        self.parser.add_argument(&#39;--paths&#39;,
                                 nargs=&#39;*&#39;,
                                 type=str,
                                 help=&#39;path to the database configuration file&#39;)

    def get_output_dir(self):
        &#34;&#34;&#34;
        Return the directory name for the tileset.
        &#34;&#34;&#34;
        if self.args.output_dir is None:
            return os.path.join(&#34;obj_tilesets&#34;, Path(self.current_path).name)
        else:
            return os.path.join(self.args.output_dir, Path(self.current_path).name)

    def parse_command_line(self):
        super().parse_command_line()

        if(self.args.paths is None):
            print(&#34;Please provide a path to a directory &#34;
                  &#34;containing some obj files or multiple directories&#34;)
            print(&#34;Exiting&#34;)
            sys.exit(1)

    def from_obj_directory(self, path):
        &#34;&#34;&#34;
        Create a tileset from OBJ files.
        :param path: a path to a directory

        :return: a tileset.
        &#34;&#34;&#34;

        objects = Objs.retrieve_objs(path, self.args.with_texture)

        if(len(objects) == 0):
            print(&#34;No .obj found in &#34; + path)
            return None
        else:
            print(str(len(objects)) + &#34; .obj parsed&#34;)

        return self.create_tileset_from_feature_list(objects)


def main():
    &#34;&#34;&#34;
    Run the ObjTiler, which creates either:
    - a repository named &#34;obj_tileset&#34; where the
    tileset is stored if the directory does only contains obj files.
    - or a repository named &#34;obj_tilesets&#34; that contains all tilesets are stored
    created from sub_directories
    and a classes.txt that contains the name of all tilesets
    :return: no return value
    &#34;&#34;&#34;
    obj_tiler = ObjTiler()
    obj_tiler.parse_command_line()
    paths = obj_tiler.args.paths

    for path in paths:
        obj_tiler.current_path = path
        if(os.path.isdir(path)):
            print(&#34;Writing &#34; + path)
            tileset = obj_tiler.from_obj_directory(path)
            if(tileset is not None):
                print(&#34;tileset in&#34;, obj_tiler.get_output_dir())
                tileset.write_as_json(obj_tiler.get_output_dir())


if __name__ == &#39;__main__&#39;:
    main()</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="py3dtilers.ObjTiler.ObjTiler.main"><code class="name flex">
<span>def <span class="ident">main</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"><p>Run the ObjTiler, which creates either:
- a repository named "obj_tileset" where the
tileset is stored if the directory does only contains obj files.
- or a repository named "obj_tilesets" that contains all tilesets are stored
created from sub_directories
and a classes.txt that contains the name of all tilesets
:return: no return value</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def main():
    &#34;&#34;&#34;
    Run the ObjTiler, which creates either:
    - a repository named &#34;obj_tileset&#34; where the
    tileset is stored if the directory does only contains obj files.
    - or a repository named &#34;obj_tilesets&#34; that contains all tilesets are stored
    created from sub_directories
    and a classes.txt that contains the name of all tilesets
    :return: no return value
    &#34;&#34;&#34;
    obj_tiler = ObjTiler()
    obj_tiler.parse_command_line()
    paths = obj_tiler.args.paths

    for path in paths:
        obj_tiler.current_path = path
        if(os.path.isdir(path)):
            print(&#34;Writing &#34; + path)
            tileset = obj_tiler.from_obj_directory(path)
            if(tileset is not None):
                print(&#34;tileset in&#34;, obj_tiler.get_output_dir())
                tileset.write_as_json(obj_tiler.get_output_dir())</code></pre>
</details>
</dd>
</dl>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="py3dtilers.ObjTiler.ObjTiler.ObjTiler"><code class="flex name class">
<span>class <span class="ident">ObjTiler</span></span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class ObjTiler(Tiler):

    def __init__(self):
        super().__init__()

        # adding positional arguments
        self.parser.add_argument(&#39;--paths&#39;,
                                 nargs=&#39;*&#39;,
                                 type=str,
                                 help=&#39;path to the database configuration file&#39;)

    def get_output_dir(self):
        &#34;&#34;&#34;
        Return the directory name for the tileset.
        &#34;&#34;&#34;
        if self.args.output_dir is None:
            return os.path.join(&#34;obj_tilesets&#34;, Path(self.current_path).name)
        else:
            return os.path.join(self.args.output_dir, Path(self.current_path).name)

    def parse_command_line(self):
        super().parse_command_line()

        if(self.args.paths is None):
            print(&#34;Please provide a path to a directory &#34;
                  &#34;containing some obj files or multiple directories&#34;)
            print(&#34;Exiting&#34;)
            sys.exit(1)

    def from_obj_directory(self, path):
        &#34;&#34;&#34;
        Create a tileset from OBJ files.
        :param path: a path to a directory

        :return: a tileset.
        &#34;&#34;&#34;

        objects = Objs.retrieve_objs(path, self.args.with_texture)

        if(len(objects) == 0):
            print(&#34;No .obj found in &#34; + path)
            return None
        else:
            print(str(len(objects)) + &#34; .obj parsed&#34;)

        return self.create_tileset_from_feature_list(objects)</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="py3dtilers.Common.tiler.Tiler" href="../Common/tiler.html#py3dtilers.Common.tiler.Tiler">Tiler</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="py3dtilers.ObjTiler.ObjTiler.ObjTiler.from_obj_directory"><code class="name flex">
<span>def <span class="ident">from_obj_directory</span></span>(<span>self, path)</span>
</code></dt>
<dd>
<div class="desc"><p>Create a tileset from OBJ files.
:param path: a path to a directory</p>
<p>:return: a tileset.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def from_obj_directory(self, path):
    &#34;&#34;&#34;
    Create a tileset from OBJ files.
    :param path: a path to a directory

    :return: a tileset.
    &#34;&#34;&#34;

    objects = Objs.retrieve_objs(path, self.args.with_texture)

    if(len(objects) == 0):
        print(&#34;No .obj found in &#34; + path)
        return None
    else:
        print(str(len(objects)) + &#34; .obj parsed&#34;)

    return self.create_tileset_from_feature_list(objects)</code></pre>
</details>
</dd>
<dt id="py3dtilers.ObjTiler.ObjTiler.ObjTiler.parse_command_line"><code class="name flex">
<span>def <span class="ident">parse_command_line</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def parse_command_line(self):
    super().parse_command_line()

    if(self.args.paths is None):
        print(&#34;Please provide a path to a directory &#34;
              &#34;containing some obj files or multiple directories&#34;)
        print(&#34;Exiting&#34;)
        sys.exit(1)</code></pre>
</details>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="py3dtilers.Common.tiler.Tiler" href="../Common/tiler.html#py3dtilers.Common.tiler.Tiler">Tiler</a></b></code>:
<ul class="hlist">
<li><code><a title="py3dtilers.Common.tiler.Tiler.create_output_directory" href="../Common/tiler.html#py3dtilers.Common.tiler.Tiler.create_output_directory">create_output_directory</a></code></li>
<li><code><a title="py3dtilers.Common.tiler.Tiler.create_tileset_from_feature_list" href="../Common/tiler.html#py3dtilers.Common.tiler.Tiler.create_tileset_from_feature_list">create_tileset_from_feature_list</a></code></li>
<li><code><a title="py3dtilers.Common.tiler.Tiler.create_tileset_from_groups" href="../Common/tiler.html#py3dtilers.Common.tiler.Tiler.create_tileset_from_groups">create_tileset_from_groups</a></code></li>
<li><code><a title="py3dtilers.Common.tiler.Tiler.get_color_config" href="../Common/tiler.html#py3dtilers.Common.tiler.Tiler.get_color_config">get_color_config</a></code></li>
<li><code><a title="py3dtilers.Common.tiler.Tiler.get_kd_tree_max" href="../Common/tiler.html#py3dtilers.Common.tiler.Tiler.get_kd_tree_max">get_kd_tree_max</a></code></li>
<li><code><a title="py3dtilers.Common.tiler.Tiler.get_output_dir" href="../Common/tiler.html#py3dtilers.Common.tiler.Tiler.get_output_dir">get_output_dir</a></code></li>
</ul>
</li>
</ul>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="py3dtilers.ObjTiler" href="index.html">py3dtilers.ObjTiler</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="py3dtilers.ObjTiler.ObjTiler.main" href="#py3dtilers.ObjTiler.ObjTiler.main">main</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="py3dtilers.ObjTiler.ObjTiler.ObjTiler" href="#py3dtilers.ObjTiler.ObjTiler.ObjTiler">ObjTiler</a></code></h4>
<ul class="">
<li><code><a title="py3dtilers.ObjTiler.ObjTiler.ObjTiler.from_obj_directory" href="#py3dtilers.ObjTiler.ObjTiler.ObjTiler.from_obj_directory">from_obj_directory</a></code></li>
<li><code><a title="py3dtilers.ObjTiler.ObjTiler.ObjTiler.parse_command_line" href="#py3dtilers.ObjTiler.ObjTiler.ObjTiler.parse_command_line">parse_command_line</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>